﻿/*----------------------------------------------------------------
//  <copyright file="ISmsSender.cs" company="MicroCloud@151504200868">
//      Copyright © 2020-2024 MicroCloud Corporation, All rights reserved.
//  </copyright>
//  <site>https://gitee.com/chenmm123/microclouds</site>
//  <last-editor>cmm</last-editor>
//  <last-date>2023-09-14 11:23</last-date>
//----------------------------------------------------------------*/

namespace MicroCloud.SMS.Sender
{
    #region "短信发送功能接口"
    /// <summary>
    /// 短信发送功能接口
    /// </summary>
    public interface ISmsSender
    {
        #region "方法"
        #region "从配置文件中获取短信模板"
        /// <summary>
        /// 从配置文件中获取短信模板
        /// </summary>
        /// <param name="smsType">短信类型</param>
        /// <returns></returns>
        Task<string> GetTemplateCodeAsync(SmsType smsType);
        #endregion
        #region "发送短信"
        /// <summary>
        /// 发送短信
        /// </summary>
        /// <param name="paramsDto">短信发送参数DTO</param>
        /// <param name="phoneNumbers">待发送手机号</param>
        /// <returns></returns>
        Task<OperationResult<SendResponse>> SendAsync(SendParamsDto paramsDto, params string[] phoneNumbers);
        #endregion
        #region "批量发送短信"
        /// <summary>
        /// 批量发送短信
        /// </summary>
        /// <param name="paramsDto">短信批量发送参数DTO</param>
        /// <returns></returns>
        Task<OperationResult<SendResponse>> SendBatchAsync(BatchSendParamsDto paramsDto);
        #endregion

        #endregion

    }
    #endregion

}
